[Rails] FriendlyId 基本教學 操作

發表於 更新於 分類於 ，

參考來源:
FriendlyId
FriendlyId完整文件

目的創造將這種網址
some_domain/products/1
變為
some_domain/products/goods1

這邊紀錄我每個步驟包括遇到的問題

步驟1: 安裝

Gemfile
1
gem 'friendly_id', '~> 5.1.0' # Note: You MUST use 5.0.0 or greater for Rails 4.0+

$ bundle install
$ rails generate friendly_id
$ rails db:migrate

步驟2: 創立表單(如果已經創立過則跳過此步驟)

FriendlyId完整文件他會教你創migration這邊用product當示範:
$ rails g model product

找到該migration

xxx_create_products.rb
1
2
3
4
5
6
7
class CreateProductLists < ActiveRecord::Migration[5.0]
  def change
    create_table :products do |t|
      t.string :title
      t.string :slug
  end
end

官方補充敘述:

Temp solution for Rails 5.1+ : Before running the migration, go into the generated migration file and specify the Rails version:
class CreateFriendlyIdSlugs < ActiveRecord::Migration[5.1]
如果Rails版本超過5.1以上請修改migration第一行

$ rake db:migrate

步驟3: 實作

找到該model

app/models/products.rb
1
2
3
4
class User < ApplicationRecord
  extend FriendlyId
  friendly_id :title, use: :slugged
end

找到該controller

products_controller.rb
1
2
3
4
5
class UserController < ApplicationController
  def show
    @product = Product.friendly.find(params[:id])
  end
end

如果跳過步驟2的到這肯定報錯，因為就有表單並沒有slug這個欄位，緊接著看步驟4！

步驟4: 新創表單並且更新所有表單(有操作到步驟2的則不用做步驟4)

$ rails g migration add_slug_to_product

找到該migration

add_slug_to_product.rb
1
2
3
4
5
class AddSlugToProduct < ActiveRecord::Migration[5.0]
  def change
    add_column :products, :slug, :string, unique: true
  end
end

$ rake db:migtate
最後在終端機更新所有表單
$ rails console
$ Product.find_each(&:save)
$ exit

大功告成！